<?php

namespace sffi\WechatRobotPlug\api;

interface FriendApiInterface
{
    /**
     * 获取好友列表
     * @param string $robotWxid 机器人微信ID
     * @param bool $fresh 是否强制刷新数据
     */
    public function getFriends(bool $fresh): array;

    /**
     * 获取微信好友详情
     * @param string $robotWxid 机器人微信ID
     * @param string $member_wxid 微信用户ID
     */
    public function getFriendDetail(string $member_wxid): array;

    /**
     * 根据手机号、微信号搜索好友
     * @param string $phoneOrWxid 手机号或微信号
     */
    public function search(string $phoneOrWxid): array;

    /**
     * 同意好友申请
     * @param string $robotWxid
     * @param string $v1
     * @param string $v2
     * @param int $type
     */
    public function agreeFriendApply(string $v1, string $v2, int $type);

    /**
     * 变更好友备注
     * @param string $robotWxid 机器人微信ID
     * @param string $toWxid 待修改人微信ID
     * @param string $note 新备注
     * @return array
     */
    public function modifyFriendNote(string $toWxid, string $note): array;

    /**
     * 删除微信好友
     * @param string $robotWxid 机器人微信ID
     * @param string $toWxid 待删除微信ID
     * @return array
     */
    public function deleteFriend(string $toWxid): array;

    /**
     * 获取好友状态
     * @param string $robotWxid
     * @param string $toWxid
     */
    public function getFriendStatus(string $toWxid);
}